home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 43 / Amiga Format CD43 (1999)(Future Publishing)(GB)(Track 1 of 2)[!][issue 1999-09].iso / -serious- / comms / other / mdoors2 / doors / aquawho / aquawho.doc < prev    next >
Text File  |  1999-06-14  |  39KB  |  1,062 lines
  1.  
  2.        _ _ ___/\______/\__ ____/\___/\__ _ _/\____ _/\_ __ __/\______
  3.       __ ________   __   /   _   ___   / ______   \___/__/     _____/
  4.          bIS/   /   /   /   //   //   /___/ __¬   /  /  /  /\__   \
  5.            /   /   /   /   //   //   /   /  \    /  /  /  /   /   /
  6.     __  _ _\____  /\____  //_  //_____  /___/\  /\_____  /\ _/   /___
  7.      _  ___ _   \/  _  _\/_  \/____ __\/ ___ _\/_______\/____   /_ _/
  8.                                                             \  /
  9.                                   present                    \/
  10.  
  11.                       a door for AmiExpress 2.xx/3.xx:
  12.  
  13.                   >>> AquaWho v2.0 by Aquarius/Outlaws <<<
  14.  
  15.  
  16.                           Copyright ©1994 Aquarius
  17.  
  18.                  Permission is granted to freely distribute
  19.                this product for non-commercial purposes only,
  20.                   as long as all files remain unmodified.
  21.  
  22.  
  23.  
  24. Archive (OTL-AW20.LHA) Contents
  25. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  26.    Filename:        Size:  Description:
  27.  
  28. Doors/AquaWho/
  29.    AquaWho.10.000   27264  Version for 68000+ and older /X than 3.30.
  30.    AquaWho.10.020   26576  Version for 68020+ and older /X than 3.30.
  31.    AquaWho.32.000   27284  Version for 68000+ and /X 3.30+.
  32.    AquaWho.32.020   26596  Version for 68020+ and /X 3.30+.
  33.    AquaWho.doc      39013  This document file.
  34.    AquaWho.guide    55365  AmigaGuide version of the doc.
  35.    CallsCounter      5728  CLI command which keeps track of # calls.
  36.    ULCounter         7480  Door which keeps track of uploads.
  37.    LookGenerator    31372  CLI command which generates look files
  38.    who.info          2339  Standard configuration icon.
  39.    who.look          1343  A sample look file (defines the output).
  40.    frontend.info     2199  Config icon for Shapechanger's frontend design.
  41.    frontend.look     1845  Look file by Shapechanger. Suits as frontend.
  42.  
  43. Doors/AquaWho/MiscIcons/
  44.    intex.info        2159  Cfg icon for /X internal who + conf (LookGen.).
  45.    nstat.info        1256  Cfg icon for Biscrok's frontend look (LookGen).
  46.    vnz.info          2641  Cfg icon for Vinzi's designs (vnz.look* below).
  47.    zin!.info         2340  Config icon for Zin!'s design (in LookGen.).
  48.  
  49. Doors/AquaWho/MiscLooks/
  50.    block.look.4ndz   1189  Look by Aquarius for 4 nodes (easy to extend).
  51.    flash.look.3ndz   1038  Look by Aquarius for 3 nodes. Edit phone #'s.
  52.    nfl.look.3ndz      964  Look by Aquarius for 3 nodes. Edit board name.
  53.    nfl.look.4ndz     1145  Same style but for 4 nodes.
  54.    vnz.look.2ndz      680  Look file by Vinzi! Really nice as frontend!
  55.    vnz.look.3ndz      800  Same but for 3 nodes.
  56.    vnz.look.4ndz      920  4-nd v. Use MiscIcons/vnz.info as config icon.
  57.  
  58. Commands/BBSCmd/
  59.    who.info          1282  Command icon for AmiExpress 3.xx.
  60.    wh.info           1282  Command icon for AmiExpress 3.xx.
  61.  
  62. Commands/SYSCmd/
  63.    filecheck.info    1043  Use this to install ULCounter.
  64.    frontend.info     1268  Use this to have AquaWho as frontend.
  65.  
  66. Previews/
  67.    bis.iff           9808  Picture of Biscrok's design (LookGenerator).
  68.    col.iff           5824  A nice design by Aquarius (LookGen.).
  69.    fire.iff          7564  A hot (hehe) look by Aquarius (LookGen).
  70.    full.iff          7214  Another nice design by Aquarius (LookGen.).
  71.    sc1.iff           9334  Shapechanger's frontend style (LookGen).
  72.    vnz.iff           4916  Vinzi's funky design (in dir MiscLooks).
  73.    zin!.iff          7630  Zin!'s design (in LookGenerator).
  74.  
  75.  
  76. Introduction
  77. ~~~~~~~~~~~~
  78. AquaWho is an AmiExpress door for multinode boards. Briefly you could say
  79. that it gives the user information about what's happening on the other
  80. nodes. There are lots of who doors out there, but this is simply the most
  81. powerful ever made! Just look at all the features...
  82.  
  83.  
  84. Features
  85. ~~~~~~~~
  86. Its output (design, look) is totally configurable!
  87.  
  88. Several design examples are included, some by well-known ascii artists. I
  89. am sure that you will find one that you like! If not, just make your own
  90. design! You can have different designs on different commands (who, wh,
  91. node, frontend etc), so you don't need a separate frontend who door.
  92.  
  93. All strings (action strings for example) can be reconfigured!
  94.  
  95. It is able to display: name/handle, location, action, current conference,
  96. access level, multichat/OLM availability (for /X 3.37+), number of calls
  97. today (for every node or for all nodes together), number of uploaded files
  98. and bytes today, and current time and date! It can even make pauses of any
  99. length, which can be used to accomplish nice animation effects.
  100.  
  101. Quiet nodes are supported. The default action string for a quiet node is
  102. "Secret action" but that can easily be reconfigured to whatever you like,
  103. "Node inactive" for example to give the impression that no-one is there.
  104.  
  105. If a user has a certain access level (configurable of course), he can see
  106. who is on a quiet node. The user name will then have a "(Q)" appended.
  107.  
  108. Of course, it can show file names, but it can also be configured not to
  109. show them when the UL/DL takes place in a conference which the user
  110. doesn't have access to. An access value required to see filenames can be
  111. set as well.
  112.  
  113. The door command being used on another node can be shown! You can
  114. configure the access level required to see the command. Conference access
  115. checking is also available, meaning that the door command will only be
  116. shown if it is clear that the AquaWho user has access to the conference in
  117. which that door is being used. This is probably not a very needed feature
  118. (the conf checking), but it's there if you want it!
  119.  
  120. The access level required to see the conference numbers can be configured.
  121. Also, the conference number can be hidden if the AquaWho user doesn't have
  122. access to that conference.
  123.  
  124. If a new user is logging into the BBS for the first time, AquaWho displays
  125. "A new user!" (configurable of course) as user name when he is typing in
  126. answers to all the new-user questions. When he is done his name/handle is
  127. displayed, with the note "(NEW)" added. If he gets validated when he is
  128. online, the "(NEW)" thing will disappear.
  129.  
  130. If a node is reserved for a user, that user's name is displayed in
  131. uppercase letters between parentheses. You can make it show a certain
  132. string instead if you want to ('Reserved' for example).
  133.  
  134. AquaWho is written in highly optimized C code for best performance!
  135.  
  136.  
  137. Requirements
  138. ~~~~~~~~~~~~
  139. An Amiga with OS 2.0 or higher.
  140. AmiExpress/SigmaExpress.
  141. (The door works for sure on /X v2.20-3.38 and possibly on other versions
  142. too.)
  143.  
  144.  
  145. Installation
  146. ~~~~~~~~~~~~
  147. You should read the entire installation text completely, since it contains
  148. lots of important information.
  149.  
  150.  
  151. First create the directory 'Doors:AquaWho', and copy the correct version
  152. of the door there.
  153.  
  154. AquaWho.10.000 is for S-Express & earlier /X than 3.30, and 68000/010.
  155. AquaWho.10.020 is for S-Express & earlier /X than 3.30 and 68020/030/040.
  156. AquaWho.32.000 is for /X 3.30 or higher, and 68000/010.
  157. AquaWho.32.020 is for /X 3.30 or higher, and 68020/030/040.
  158.  
  159. It could also be a good idea to copy the documentation to that directory,
  160. because you will probably need it in the future.
  161.  
  162. Now you must decide what commands you want to have AquaWho on, probably
  163. 'who', 'wh' and perhaps 'frontend' and some more.
  164.  
  165.  
  166. For every command, you need to fix THREE things.....
  167.  
  168.  
  169. 1. The normal XIM door installation...
  170.  
  171.    /X 3.xx:
  172.  
  173.    Copy Commands/BBSCmd/who.info from the archive to your BBSCmd directory
  174.    as <command>.info (who.info, wh.info etc) and check that its tooltypes
  175.    LOCATION and ACCESS are correct.
  176.  
  177.    If you will install it as frontend, copy the same icon to Frontend.info
  178.    in your SYSCmd directory.
  179.  
  180.  
  181.    /X 2.xx, SigmaExpress:
  182.  
  183.    Add a line to your BBS.CMD, for example:
  184.  
  185.    -----Cut-here-------------------------------
  186.    *WHO      XM020Doors:AquaWho/AquaWho.10.020
  187.    --------Cut-here----------------------------
  188.                   ^--- File name of the door with full path.
  189.                ^^^
  190.     ^          Access required to use the door.
  191.     |
  192.     ` The command that will invoke AquaWho.
  193.  
  194.    For frontend installation, add this to your SYS.CMD file:
  195.    -----Cut-here-------------------------------
  196.    FRONTEND  XM020Doors:AquaWho/AquaWho.10.020
  197.    --------Cut-here----------------------------
  198.  
  199.  
  200. 2. You must have a look file, 'Doors:AquaWho/<command>.look'. It tells the
  201.    door what to display. For a quick installation, I recommend that you
  202.    use the LookGenerator utility to create the look file. Just open a
  203.    shell window and start it, and you'll see how to use it. It contains
  204.    many nice designs.
  205.  
  206.  
  207. 3. You must also have a configuration icon for every command:
  208.    'Doors:AquaWho/<command>.info'. Use the supplied icon
  209.    'Doors/AquaWho/who.info' and check that its tooltypes are correct.
  210.    Especially all access values (ACS.*) should be thoroughly checked!!
  211.    That they are alright for ONE look file doesn't mean they're good for
  212.    another. If they are set wrong, too little or too much info could be
  213.    shown (security!), or the door could be slower than what is possible
  214.    (see ACS.SEE_CONFS e.g.). All tooltypes are described in detail in a
  215.    section below.
  216.  
  217.  
  218. The CallersLog must be turned on if you are going to use a who design that
  219. shows the current conference.
  220.  
  221. If you are using relative conferences, the conference numbers AquaWho
  222. shows might not be the same for all users on your board. But if they all
  223. have access to the x first conferences, there's no problem. For example,
  224. it's not good if you're using relative conferences and some users' access
  225. looks like this: XX_X__X__ or X_XXX____. Better: XXX______ and XXXX_____,
  226. as examples. (AmiExpress 3.xx doesn't have these conference access
  227. strings, but you get the point anyway.) So if you have the "bad" case,
  228. either turn off relative conferences, or don't use a look file with
  229. conference codes.
  230.  
  231. The DoorLog must be turned on if you have /X 3.xx and you don't have the
  232. tooltype DISABLE_EXTRA in the config icon. The DoorLog is then used to
  233. determine if the logoff module is running.
  234. You also need to have it turned on if you want the door commands being
  235. used on other nodes to be shown (if ACS.SEE_DOORS is 255 or lower).
  236.  
  237. To turn on the DoorLog with /X 2.xx, put 'NODE* DOORLOG' in ACP.STARTUP.
  238. For /X 3.xx, put the tooltype 'DOOR_LOG' in the node icons.
  239.  
  240. The DoorLog grows very large quickly I'm afraid... The best solution to
  241. this is to use my utility "Stripper" (released separately) about once a
  242. day. It rips off the beginning of the file, to a size of your choice. 1000
  243. bytes is appropriate I guess. Use it like this: "Strip BBS:Node(x)/DoorLog
  244. 1000".
  245.  
  246. If you are going to use a who design that shows number of calls, you must
  247. install the CallsCounter utility. Run it in your logoff scripts with the
  248. node number as its only argument. For example, in the logoff script for
  249. node 3, add "Doors:AquaWho/CallsCounter 3".
  250.  
  251. To use a look file with uploaded files or bytes today, ULCounter must be
  252. installed as the FILECHECK door. It's possible that you already have
  253. another tool installed there. If it is Sigma Seven's DupeChecker, you can
  254. install ULCounter as the SERVER command (in SYSCmd) instead. But if your
  255. FILECHECK door doesn't offer such a possibility, you can use
  256. '5D-MultiStart' (by Sven the Creator/5D). Then you can have as many
  257. FILECHECKers as you want!
  258.  
  259.  
  260. Configuration
  261. ~~~~~~~~~~~~~
  262.  
  263. The Tooltypes
  264. =============
  265.  
  266. A tip: For you who didn't know this, ANSI codes can be used in tooltypes.
  267. To write the escape character, press lamiga+ctrl+esc...
  268.  
  269. Here follows descriptions of all tooltypes possible to have in a
  270. configuration icon ('Doors:AquaWho/<command>.info'):
  271.  
  272.  
  273. RESET_LINES                         optional
  274.  
  275. If this tooltype is present in the config icon, the number of lines viewed
  276. is first set to zero, to prevent the pause prompt from appearing too soon.
  277. This can be useful when the door is used as frontend or is started with
  278. MCI, but it makes no difference when the door is started from the main
  279. prompt.
  280.  
  281.  
  282. NONSTOP                             optional
  283.  
  284. If you never want any pause prompt in the who door, use this tooltype. It
  285. turns on non-stop scrolling when the door starts and turns it off when it
  286. quits.
  287.  
  288.  
  289. FRONTEND                            optional
  290.  
  291. If you want to run the door before the logon prompt (handle/password), for
  292. example by using MCI in Private.txt or BBSTitle.txt, or as FRONTEND door,
  293. then put this tooltype in the config icon. Actually, it is not needed for
  294. true FRONTEND usage - the door can detect that. The effect is, among other
  295. things, that the door user's access level is considered to be 0.
  296.  
  297.  
  298. GET_BAUD                            optional
  299.  
  300. If the look file has baud codes in it, this tooltype must be in the icon.
  301. The door will complain if it finds a baud code but not this tooltype. If
  302. you don't want connect baud to be shown, you should not have this
  303. tooltype, because it would make the who door a bit slower (perhaps not
  304. noticably but still).
  305.  
  306.  
  307. DISABLE_EXTRA                       optional
  308.  
  309. If this is present in the icon, AquaWho will act more like every other who
  310. door in the sense that it will not show "(NEW)" for new users and not read
  311. the DoorLog to check if the logoff module is running (/X 3.xx).
  312.  
  313.  
  314. DOORCMD_UPCASE                      optional
  315.  
  316. If this tooltype is present, door commands are shown in uppercase letters,
  317. otherwise in lowercase.
  318.  
  319.  
  320. DOORCMD_INITIAL                     optional
  321.  
  322. If this tooltype is present, the first letter in the door command is
  323. written in lowercase if the other letters are to be written in uppercase
  324. (determined by the tooltype DOORCMD_UPCASE), and in uppercase if the other
  325. letters are to be written in lowercase.
  326.  
  327. Example ('dis' command):
  328.  
  329. DOORCMD_UPCASE  DOORCMD_INITIAL  : dIS
  330. -               DOORCMD_INITIAL  : Dis
  331. DOORCMD_UPCASE  -                : DIS
  332. -               -                : dis
  333.  
  334.  
  335. ACS.SEE_FILES=<access level>        required
  336.  
  337. This is the minimum access level required to see the names of the files
  338. being uploaded or downloaded.
  339.  
  340.  
  341. ACS.SEE_CONFS=<access level>        required
  342.  
  343. This is the minimum access level required to see conference numbers. If
  344. the look file doesn't contain any conference codes, set this higher than
  345. 255. That will possibly make the door faster beacause it won't read the
  346. CallersLogs then (unless it needs to check conference access, see
  347. ACS.NO_CONF_ACS_CHECK.FILES and company).
  348.  
  349.  
  350. ACS.SEE_ACCESS=<access level>       required
  351.  
  352. This is the minimum access level required to see other users' access
  353. level. If there are no access codes in the look file, set this higher than
  354. 255. That will make the door a bit faster.
  355.  
  356.  
  357. ACS.SEE_QUIET_NODES=<access level>  required
  358.  
  359. This is the minimum access level required to get all information about a
  360. node which is quiet. A "(Q)" will be appended to the handles on quiet
  361. nodes.
  362.  
  363.  
  364. ACS.SEE_NEW=<access level>         required (unless DISABLE_EXTRA is used)
  365.  
  366. This is the minimum access level required to see if a user is new (not
  367. validated and calling for the first time). "(NEW)" is appended to those
  368. users' names.
  369.  
  370.  
  371. ACS.SEE_DOORS=<access level>        required
  372.  
  373. This is the minimum access level required to see what door commands are
  374. being used on the other nodes.
  375.  
  376.  
  377. ACS.NO_CONF_ACS_CHECK.FILES=<access level>  req. (if ACS.SEE_FILES <= 255)
  378.  
  379. This is the minimum access level required to avoid conference access
  380. checking that could hide filenames. If a user has a lower access, he can
  381. ONLY see the filenames IF it is clear that he has access to the conference
  382. where the upload/download takes place.
  383.  
  384.  
  385. ACS.NO_CONF_ACS_CHECK.CONFS=<access level>  req. (if ACS.SEE_CONFS <= 255)
  386.  
  387. This is the minimum access level required to avoid conference access
  388. checking that could hide conference numbers. If a user has a lower access,
  389. he can ONLY see the conference number of another user IF it is clear that
  390. he has access to that conference.
  391.  
  392.  
  393. ACS.NO_CONF_ACS_CHECK.DOORS=<access level>  required
  394.  
  395. This is the minimum access level required to avoid conference access
  396. checking that could hide door commands. If a user has a lower access, he
  397. can ONLY see the door command being used by another user IF it is clear
  398. that he has access to that conference.
  399.  
  400.  
  401. METACHAR=<character>                optional, default: '°'
  402.  
  403. This is the character that is the beginning of the special codes in look
  404. files. See the section that describes the look files in detail.
  405.  
  406.  
  407. NOCONFCHAR=<character>              optional, default: '-'
  408.  
  409. When there is no user on a node or he hasn't joined a conference yet, or
  410. the conference number couldn't be determined for some reason, this
  411. character is shown instead of the conference number.
  412.  
  413. If padding with zeros is turned on, the space reserved will be filled with
  414. this character.
  415.  
  416.  
  417. SECRETCONFCHAR=<character>          optional, default: 'x'
  418.  
  419. If a node is quiet or the door user hasn't got access to see conference
  420. numbers, this character will be shown instead.
  421.  
  422.  
  423. NOACCESSCHAR=<character>            optional, default: '-'
  424.  
  425. If the access level can't be determined, for example when there is no user
  426. on the node, this character is shown instead.
  427.  
  428.  
  429. SECRETACCESSCHAR=<character>        optional, default: 'x'
  430.  
  431. If the node is quiet or the door user hasn't the access set by
  432. ACS.SEE_ACCESS, this character is shown instead of the access level.
  433.  
  434.  
  435. NOBAUDCHAR=<character>              optional, default: ' '
  436.  
  437. Whenever the connect bps can't be determined, for example when there is no
  438. user on the node, this character is shown instead.
  439.  
  440.  
  441. SECRETBAUDCHAR=<character>          optional, default: 'x'
  442.  
  443. If a node is quiet, this character will be shown instead of the connect
  444. bps.
  445.  
  446.  
  447. ADD_TO_BAUD=<string>                optional, default: ''
  448.  
  449. This tooltype lets you specify a string which will be appended to the
  450. connect bps when that can be determined, or the node is quiet (and
  451. SECRETBAUDCHAR isn't a space). For example, if you enter ' bps' here, this
  452. could be shown:
  453.  
  454. 14000 bps   Joining a conf   (' bps' was added)
  455.             Awaiting connect (could not determine baud -> no ' bps')
  456.     x bps   Secret action    (quiet node, ' bps' was added)
  457.  
  458.  
  459. CHAT_NO=<string>                    optional, default: 'NO '
  460.  
  461. This string is inserted as multichat/OLM availability when the user is NOT
  462. available. Its length should be the same as CHAT_YES.
  463.  
  464.  
  465. CHAT_YES=<string>                   optional, default: 'YES'
  466.  
  467. This string is inserted as multichat/OLM availability when the user IS
  468. available. Its length should be the same as CHAT_NO.
  469.  
  470.  
  471. NOTACTIVENAME=<string>              optional, default: 'Nobody'
  472.  
  473. This is the string that is shown as user name when the node is resetting
  474. itself (when the action is NOTACTIVE).
  475.  
  476.  
  477. AWAITCONNECTNAME=<string>           optional, default: 'Nobody'
  478.  
  479. This is the string that is shown as user name when the node is ready to
  480. receive a call (when the action is AWAITCONNECT).
  481.  
  482.  
  483. SHUTDOWNNAME=<string>               optional, default: 'Nobody'
  484.  
  485. This is the string that is shown as user name when the node is shutdown,
  486. not active (when the action is SHUTDOWN).
  487.  
  488.  
  489. SUSPENDNAME=<string>                optional, default: 'Nobody'
  490.  
  491. This is the string that is shown as user name when the node is suspended
  492. (when the action is SUSPEND).
  493.  
  494.  
  495. RESERVENAME=<string>                optional
  496.  
  497. If you don't want the name of the user whom the node is reserved for to be
  498. shown (like this: "( USERNAME )"), then use this tooltype to determine
  499. what should be shown instead ('Reserved' for example).
  500.  
  501.  
  502. NOWHERE=<string>                    optional, default: 'Nowhere'
  503.  
  504. This is the string that is shown as location when nobody is on the node.
  505.  
  506.  
  507. SOMEBODY=<string>                   optional, default: 'Somebody'
  508.  
  509. This string is shown as user name when somebody is connecting to the BBS
  510. (when the action is CONNECT), and at all other occasions when somebody is
  511. online but the name cannot be determined.
  512.  
  513.  
  514. SOMEWHERE=<string>                  optional, default: 'Somewhere'
  515.  
  516. This string is shown as location when:
  517.  - a new user is logging on (action ACCOUNTSEQ).
  518.  - a user is connecting to the BBS (action CONNECT).
  519.  - the node is reserved for a user (action RESERVE).
  520.  - somebody is online but the name cannot be determined.
  521.  
  522.  
  523. SECRETNAME=<string>                 optional, default: 'Somebody'
  524.  
  525. This string is shown as user name when a node is quiet (and the AquaWho
  526. user hasn't got the access defined by ACS.SEE_QUIET_NODES). The action
  527. string will then be what is defined by the tooltype SECRET.
  528.  
  529.  
  530. SECRETLOC=<string>                  optional, default: 'Somewhere'
  531.  
  532. This string is shown as location when a node is quiet (and the AquaWho
  533. user hasn't got the access defined by ACS.SEE_QUIET_NODES). The action
  534. string will then be what is defined by the tooltype SECRET.
  535.  
  536.  
  537. NEWUSER=<string>                    optional, default: 'A new user!'
  538.  
  539. This is the string that is shown as user name when a new user is logging
  540. on, answering new-user questions. The action is then ACCOUNTSEQ.
  541.  
  542.  
  543. USERNAME=<string>                   optional
  544.  
  545. If you don't want ANY of the users' names to be shown, then use this
  546. tooltype to set the replacement string. (The AquaWho user's name is not
  547. affected by this, see YOURNAME.) This is primarily intended for frontend
  548. usage, where you can write 'USERNAME=**BUSY**' for example.
  549.  
  550.  
  551. YOURNAME=<string>                   optional, default for frontend: 'You!'
  552.  
  553. If you don't want the AquaWho user's name to be shown, then use this
  554. tooltype to set the replacement string. When AquaWho is used as frontend
  555. door, this tooltype defines the user's name.
  556.  
  557.  
  558. YOURNAMEQ=<string>                  optional, default: 'You! (Quiet)'
  559.  
  560. This string is shown as name for the AquaWho user when the node is quiet
  561. and one of the following criteria holds:
  562.  - it is a frontend command
  563.  - YOURNAME is present in the config icon
  564.  - the user doesn't have the access set by ACS.SEE_QUIET_NODES
  565.  
  566.  
  567. YOUFRONTLOC=<string>                optional, default: ''
  568.  
  569. This is the location string for the AquaWho user when the door is used as
  570. frontend.
  571.  
  572.  
  573. Tooltypes describing actions:
  574. -----------------------------
  575.  
  576. IDLE=<string>                       optional, default: 'Doing nothing'
  577.  
  578. This is the string shown when the user is at the main prompt, perhaps
  579. typing a command.
  580.  
  581.  
  582. DOWNLOADING=<string>                optional, default: 'Downloading'
  583.  
  584. The user is downloading but the filename is not shown. Possible reasons:
  585.  1. The door user's access level is lower than what is specified in
  586.     ACS.SEE_FILES.
  587.  2. ACS.NO_CONF_ACS_CHECK.FILES is set higher than the AquaWho user's
  588.     access level (therefore conf access checking is done), and he doesn't
  589.     have access to the conference in which the download takes place.
  590.  3. He is typing file names to download and has not yet begun the
  591.     transfer.
  592.  4. He chose 'goodbye after transfer' and is logging off.
  593.  5. The AquaWho user doesn't have the access defined by
  594.     ACS.NO_CONF_ACS_CHECK.FILES and you are using relative conferences.
  595.     Then you must either remove conference access checking by setting
  596.     ACS.NO_CONF_ACS_CHECK.FILES to 0 (also ACS.NO_CONF_ACS_CHECK.CONFS and
  597.     ACS.NO_CONF_ACS_CHECK.DOORS) or stop using relative conferences,
  598.     because the conference access checking doesn't work with relative
  599.     conferences (unless the conference numbers for all users are the same
  600.     with, as without relative conferences)!
  601.  
  602.  
  603. DLFILE=<string>                     optional, default: 'DL: '
  604.  
  605. This string is shown as action with the filename appended, when a user is
  606. downloading. Note that no space is automatically inserted between this
  607. string and the filename (for more configuration freedom).
  608.  
  609.  
  610. UPLOADING=<string>                  optional, default: 'Uploading'
  611.  
  612. The user is uploading, but the filename is not shown. Possible reasons:
  613.  1. The door user's access level is lower than what is specified in
  614.     ACS.SEE_FILES.
  615.  2. ACS.NO_CONF_ACS_CHECK.FILES is set higher than the AquaWho user's
  616.     access level (therefore conf access checking is done), and he doesn't
  617.     have access to the conference in which the upload takes place.
  618.  3. The actual transfer has not yet begun.
  619.  4. He chose 'goodbye after transfer' and is logging off.
  620.  5. The AquaWho user doesn't have the access defined by
  621.     ACS.NO_CONF_ACS_CHECK.FILES and you are using relative conferences.
  622.     Then you must either remove conference access checking by setting
  623.     ACS.NO_CONF_ACS_CHECK.FILES to 0 (also ACS.NO_CONF_ACS_CHECK.CONFS and
  624.     ACS.NO_CONF_ACS_CHECK.DOORS) or stop using relative conferences,
  625.     because the conference access checking doesn't work with relative
  626.     conferences (unless the conference numbers for all users are the same
  627.     with, as without relative conferences)!
  628.  
  629.  
  630. ULFILE=<string>                     optional, default: 'UL: '
  631.  
  632. This string is shown as action with the filename appended, when a user is
  633. downloading. Note that no space is automatically inserted between this
  634. string and the filename (for more configuration freedom).
  635.  
  636.  
  637. DOORS=<string>                      optional, default: 'Using a door'
  638.  
  639. The user is using a door, an external module, but the door command is not
  640. shown. Possible reasons:
  641.  1. The door user's access level is lower than what is specified in
  642.     ACS.SEE_DOORS.
  643.  2. ACS.NO_CONF_ACS_CHECK.DOORS is set higher than the AquaWho user's
  644.     access level (therefore conf access checking is done), and he doesn't
  645.     have access to the conference in which the door is being used.
  646.  3. The last line in the DoorLog didn't contain a door command.
  647.  4. There was an error reading the DoorLog. Make sure that the tooltype
  648.     DOOR_LOG is present in the BBS:Node(x).info icons (for /X 3.xx).
  649.  5. The AquaWho user doesn't have the access defined by
  650.     ACS.NO_CONF_ACS_CHECK.DOORS and you are using relative conferences.
  651.     Then you must either remove conference access checking by setting
  652.     ACS.NO_CONF_ACS_CHECK.DOORS to 0 (also ACS.NO_CONF_ACS_CHECK.FILES
  653.     and ACS.NO_CONF_ACS_CHECK.CONFS) or stop using relative conferences,
  654.     because the conference access checking doesn't work with relative
  655.     conferences (unless the conference numbers for all users are the same
  656.     with, as without relative conferences)!
  657.  
  658.  
  659. DOORCMD=<string>                    optional, default: 'Using door: '
  660.  
  661. This string is shown as action with the door command appended when a user
  662. is using a door. If the door command isn't shown, see the tooltype DOORS
  663. for reasons. Note that no space is automatically inserted between this
  664. string and the door command (for more configuration freedom).
  665.  
  666.  
  667. MAIL=<string>                       optional, default: 'R/W mail'
  668.  
  669. This is the action string shown when the user is reading or writing mail
  670. (not at logon, which is SCANNING).
  671.  
  672.  
  673. STATS=<string>                      optional, default: 'Checking status'
  674.  
  675. This is the action string shown when the user is using the 'w' or 's'
  676. standard AmiExpress command.
  677.  
  678.  
  679. ACCOUNT=<string>                    optional, default: 'Account editing'
  680.  
  681. This is the action string shown when the user is editing accounts, or at
  682. least it should be but I don't think that AmiExpress uses it at all. When
  683. the account editor is used (command '1') the action is SYSOP.
  684.  
  685.  
  686. ZOOM=<string>                       optional, default: 'Zooming mail'
  687.  
  688. This is the action string shown when the user is zooming mail (collecting
  689. for download).
  690.  
  691.  
  692. FILES=<string>                      optional, default: 'Scanning files'
  693.  
  694. This is the action string shown when the user is viewing a filelist.
  695. Internal /X commands resulting in this action: 'f', 'n', 'z' and 'a'.
  696.  
  697.  
  698. BULLETINS=<string>                  optional, default: 'Reading bulletins'
  699.  
  700. This is the action string shown when the user is reading bulletins (the
  701. 'b' command).
  702.  
  703.  
  704. VIEWING=<string>                    optional, default: 'Viewing text file'
  705.  
  706. This is the action string shown when the user is viewing a file, with the
  707. 'v' or 'vs' command.
  708.  
  709.  
  710. ACCOUNTSEQ=<string>                 optional, default: 'Logging on'
  711.  
  712. This is the action string shown when the user is logging on the BBS for
  713. the first time (answering new-user questions etc).
  714.  
  715.  
  716. LOGOFF=<string>                     optional, default: 'Logging off'
  717.  
  718. This is the action string shown when the user is logging off.
  719.  
  720.  
  721. SYSOP=<string>                      optional, default: 'Sysop activities'
  722.  
  723. This string is shown as action when the user is using a sysop command such
  724. as '1', '2' and '5'.
  725.  
  726.  
  727. SHELL=<string>                      optional, default: 'Using Shell'
  728.  
  729. This is the action string shown when the user is in the Shell.
  730.  
  731.  
  732. EMACS=<string>                      optional, default: 'Using EMACS'
  733.  
  734. This is the action string shown when the user is editing using EMACS.
  735. AmiExpress commands: '3' and '4'.
  736.  
  737.  
  738. JOIN=<string>                       optional, default: 'Joining a conf'
  739.  
  740. This is the action string shown when the user is joining a conference.
  741.  
  742.  
  743. CHAT=<string>                       optional, default: 'Chatting'
  744.  
  745. This is the action string shown when the user is chatting with the sysop.
  746.  
  747.  
  748. NOTACTIVE=<string>                  optional, default: 'Awaiting connect'
  749.  
  750. This is the action string shown when someone just logged off and the node
  751. is being resetted.
  752.  
  753.  
  754. REQ_CHAT=<string>                   optional, default: 'Paging Sysop'
  755.  
  756. This is the action string shown when the user is paging the sysop
  757. (requesting chat).
  758.  
  759.  
  760. CONNECT=<string>                    optional, default: 'Connecting to BBS'
  761.  
  762. This is the action string shown when someone is connecting to the BBS.
  763.  
  764.  
  765. LOGGINGON=<string>                  optional, default: 'Logging on'
  766.  
  767. This is the action string shown when the user is logging on the BBS.
  768.  
  769.  
  770. AWAITCONNECT=<string>               optional, default: 'Awaiting connect'
  771.  
  772. This is the action string shown when the node is free for call.
  773.  
  774.  
  775. SCANNING=<string>                   optional, default: 'Scanning for mail'
  776.  
  777. This is the action string shown when the user just logged on and is
  778. scanning for mail.
  779.  
  780.  
  781. SHUTDOWN=<string>                   optional, default: 'Node inactive'
  782.  
  783. This is the action string shown when the node is not active.
  784.  
  785.  
  786. SHUTDOWN.<node>=<string>            optional
  787.  
  788. With this tooltype you can define a string that will be shown only for the
  789. specified node when it is shutdown. The intended use was to have "Sysop
  790. calling out!" or something similar for the nodes that can be used for
  791. that. For example, if you always use node 3 for calling out, write
  792. "SHUTDOWN.3=Sysop calling out!". It can be used for any info on why that
  793. node is down.
  794.  
  795.  
  796. MULTICHAT=<string>                  optional, default: 'MultiNd chatting'
  797.  
  798. This is the action string shown when the user is using a multi-node chat
  799. door.
  800.  
  801.  
  802. SUSPEND=<string>                    optional, default: 'Node suspended'
  803.  
  804. This is the action string shown when the node is suspended.
  805.  
  806.  
  807. RESERVE=<string>                    optional, default: 'Node reserved'
  808.  
  809. This is the action string shown when the node is reserved.
  810.  
  811.  
  812. OLM=<string>                        optional, default: 'Writing OLM'
  813.  
  814. This is the action string shown when the user is writing an online
  815. message. This far, it's probably only the internal OLM command in /X
  816. 3.37+ that can cause this action.
  817.  
  818.  
  819. NUKE=<string>                       optional, default: 'Nuking files'
  820.  
  821. This is the action string shown when the user is using a faker/nuker door.
  822. Not all nukers support this, so for some the action could be "Using door:
  823. nuke", "Using door: fake", or just "Using a door" (if ACS.SEE_DOORS is too
  824. high). Information for door coders: The environment code for this is 99.
  825.  
  826.  
  827. SECRET=<string>                     optional, default: 'Secret action'
  828.  
  829. This is the action string shown when the node is quiet and the AquaWho
  830. user hasn't got the access defined by ACS.SEE_QUIET_NODES.
  831.  
  832.  
  833. AQUAWHO=<string>                    optional, default: 'Using AquaWho!'
  834.  
  835. This is the action always shown for the AquaWho user (unless the node is
  836. quiet and he hasn't got the access defined by ACS.SEE_QUIET_NODES).
  837.  
  838.  
  839. UNKNOWN=<string>                    optional, default: 'Unknown action!'
  840.  
  841. This is the action string shown when the action couldn't be determined
  842. (AmiExpress' environment value was unknown).
  843.  
  844.  
  845.  
  846. The Look File
  847. =============
  848.  
  849. A look file is an ordinary ascii/ansi text file, but with special code
  850. sequences which AquaWho replaces with the item that they stand for.
  851.  
  852. Every item specification starts with the metachar, which is defined in the
  853. configuration icon, tooltype METACHAR. The default is ° (alt-w). If that
  854. character is used in the look file for other purposes ("decoration"),
  855. change the metachar to another, unique, character.
  856.  
  857.  
  858.     °D   Door name ("AquaWho").
  859.  
  860.     °V   Door version, for example "2.0".
  861.  
  862.     °P   Programmer ("Aquarius/OTL").
  863.  
  864.     °T   Current time (HH:MM:SS).
  865.  
  866.     °E   Current date (MM-DD-YY).
  867.  
  868.     °F   Full time and date string (DDD MMM dd hh:mm:ss YYYY),
  869.          for example "Wed Sep 04 15:13:22 1985".
  870.     ^
  871.     |
  872.     `-- Metachar
  873.  
  874.  
  875.     °W24    Wait for 24/50 (=0.48) seconds. This can be used to accomplish
  876.       ^^    nice animation effects.
  877.       ||
  878.       ``
  879.        There must always be TWO digits. Write °W08 to wait for 8/50 s.
  880.        If you need a longer delay than 99/50 s, use multiple wait codes.
  881.  
  882.  
  883.     °0N18L           The door will replace this with the name of the
  884.      ^^^ ^           user on node 0. 18 spaces will be reserved for it
  885.      ||| |           and it will be left justified.
  886.      ||| |
  887.      ||| |
  888.      ||| `-- Justification info: L - left justified
  889.      |||                         R - right justified
  890.      |||                         C - centered
  891.      |||
  892.      ||`-- Field width (the number of spaces to be reserved).
  893.      ||    For conf, baud, access, calls, uploads and uploaded bytes: If
  894.      ||    the field width starts with a zero, then zeros will be used for
  895.      ||    padding instead of spaces in front of the number, and if the
  896.      ||    field width is too small for the number to fit then it will be
  897.      ||    extended to whatever is needed. Look below to see what the
  898.      ||    field width limits are.
  899.      ||
  900.      |`-- Type of data: N - name
  901.      |                  L - location
  902.      |                  A - action
  903.      |                  C - conference
  904.      |                  B - connect bps
  905.      |                  X - access level
  906.      |                  S - calls (requires the CallsCounter util to be
  907.      |                             run in the logoff scripts)
  908.      |                  U - uploads (requires the ULCounter door to be run
  909.      |                               for every uploaded file, for example
  910.      |                               as FILECHECK)
  911.      |                  Y - uploaded bytes (requires the ULCounter door to
  912.      |                           be installed as FILECHECK, nothing else!)
  913.      |
  914.      |
  915.      `-- Node number (0-9 for the 10-node v., 0-31 for the 32-node v.)
  916.          NOTE! For calls, uploads and uploaded bytes you can leave this
  917.          out! Then the TOTAL count (the sum from all nodes) will be
  918.          inserted.
  919.  
  920.  
  921.     °0H  MultiChat/OLM availability. See CHAT_YES and CHAT_NO.
  922.      ^
  923.      |
  924.      `-- Node number
  925.  
  926.  
  927.  Here follows the field width limits:
  928.  
  929.   9 <= Name       <= 38
  930.   1 <= Location   <= 30
  931.   1 <= Action     <= 50
  932.   1 <= Conf       <=  8
  933.   1 <= Baud       <= 30
  934.   1 <= Access     <=  4
  935.   1 <= ChatAvail  <= 40
  936.   1 <= Calls      <=  8
  937.   1 <= UL'd Files <=  8
  938.   1 <= UL'd Bytes <= 12
  939.  
  940.  
  941.  
  942. Some examples:
  943.  
  944.  Code     Explanation                                     Sample results
  945.  ¯¯¯¯¯¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  946.  "°2S3R"  # calls today on node 2.                     "  8", " 13", "102"
  947.  "°2S03R" Same but padded with zeros.                  "008", "013", "102"
  948.  "°S3L"   # calls today on all nodes together.         "9  ", "35 ", "102"
  949.  
  950.  
  951.  
  952. Error Messages
  953. ~~~~~~~~~~~~~~
  954. These are all the error messages that AquaWho can give you. An explanation
  955. of them is given, why they appear and what you can do about it.
  956.  
  957.  
  958. Couldn't find multicom port! Check ACP.info!
  959.  
  960.    The tooltype MULTICOM_PORT must be in your ACP icon. (/X 3.xx)
  961.  
  962.  
  963. Couldn't open icon.library!
  964.  
  965.    This will probably never occur...
  966.  
  967.  
  968. Out of memory!
  969.  
  970.    You are really low on memory if this comes up. AquaWho doesn't consume
  971.    much.
  972.  
  973.  
  974. Couldn't load config icon!!
  975.  
  976.    Doors:AquaWho/<command>.info couldn't be opened.
  977.  
  978.  
  979. Error in config icon! Access value missing or invalid!
  980.  
  981.    Check the tooltypes ACS.SEE_FILES, ACS.SEE_CONFS,
  982.    ACS.SEE_QUIET_NODES, ACS.SEE_NEW, ACS.SEE_DOORS, ACS.SEE_ACCESS,
  983.    ACS.NO_CONF_ACS_CHECK.FILES, ACS.NO_CONF_ACS_CHECK.CONFS and
  984.    ACS.NO_CONF_ACS_CHECK.DOORS.
  985.  
  986.  
  987. Error in look file, line <nr> column <nr>!
  988.  
  989.    This tells you where the first error in Doors:AquaWho/<command>.look
  990.    was encountered. Load the look file into an ordinary text editor and
  991.    locate the error.
  992.  
  993.  
  994. Couldn't open look file!
  995.  
  996.    Doors:AquaWho/<command>.look couldn't be opened.
  997.  
  998.  
  999. Error reading look file!
  1000.  
  1001.    An error occurred when AquaWho was reading
  1002.    Doors:AquaWho/<command>.look. The file could be opened but there was a
  1003.    read error.
  1004.  
  1005.  
  1006. Error in config icon, tooltype <tooltype>!
  1007.  
  1008.    The tooltype is one of METACHAR, NOCONFCHAR, SECRETCONFCHAR,
  1009.    NOACCESSCHAR, SECRETACCESSCHAR, NOBAUDCHAR and SECRETBAUDCHAR.
  1010.    Check that there is exactly one character there. Note that the error
  1011.    can NOT mean that the tooltype doesn't exist. There are default
  1012.    characters for all of them.
  1013.  
  1014.  
  1015. Error! Connect bps can't be shown unless the GET_BAUD tooltype
  1016. is present in the config icon!
  1017.  
  1018.    What this means should be obvious. Put GET_BAUD in the config icon.
  1019.  
  1020.  
  1021. Contact Me!
  1022. ~~~~~~~~~~~
  1023. I want new nice look files (and their config icons if they are special)!
  1024. Give them to me and I might include them in the next release of AquaWho or
  1025. in a separate design collection. Of course I won't mind if you release
  1026. your own collection...
  1027.  
  1028. Also if you have any cool ideas for improvement of this tool, bug reports,
  1029. questions, or whatever, leave me a message on one of the following boards:
  1030.  
  1031. NIGHTFALL ................ Prof Do Right ..... +46-90-120369
  1032. OVERLOAD (OTL SHQ) ....... Vegas ............. +46-8-54063666
  1033. HYSTERIA ................. JAC ............... +46-21-842939
  1034. RAISING HELL ............. Psychopath ........ +46-23-26893
  1035. INSIDE OUT ............... C/\TE¥E ........... +46-346-58697
  1036. SNAKE'S DEN (OTL WHQ) .... Snake ............. +1-513-683-2330
  1037. THE HOLE ................. Oldman ............ +1-419-899-2754
  1038.  
  1039.  
  1040. History
  1041. ~~~~~~~
  1042. History restarted! There are so many news from v1.2 (the previous release)
  1043. that I don't have the time to explain them all.
  1044.  
  1045. 2.0  (1994-04-24) Release version.
  1046.  
  1047.  
  1048. Greetings
  1049. ~~~~~~~~~
  1050.                Greetings must go to (in no special order):
  1051.  
  1052.       - All Members of Outlaws!! - Prof Do Right/Classic - JAC/TDS -
  1053.     - C/\TE¥E/Insane - Ace Caze/Obscene - Wilsom/Obscene - Kid Curry -
  1054.    - Psychopath - Vinzi - Karma - Zin - Shapechanger - Rize - Seagull -
  1055.     - Remix/Classic - RaJ-Ban - fanta/Therion - Static/Therion - CaT -
  1056.      - Dansken - AXL/Attention - Rad!/LSD - Vileius! - Marwin/Duplo -
  1057.       - Freddy Kreuger/GOD - Chig/TDS - The Silencer - Vampire/PDY -
  1058.        - Crocodile/Obscene - Sal-One - Nojje - Zune/HCD - MadCap -
  1059.            - Metalbasher - WarDancer/H&V - The Ones I Forgot! -
  1060.  
  1061.  
  1062. [EOF]